Platform Explorer / Nuxeo Platform 2021.7

Extension point elasticSearchClient

Documentation

Extension point to define how to access the Elasticsearch cluster.

For the TransportClient protocol:

    <elasticSeachClient class="org.nuxeo.elasticsearch.client.ESTransportClientFactory">
        <option name="addressList">localhost:9300</option>
        <option name="clusterName">elasticsearch</option>
        <option name="clientTransportSniff">false</option>
        <option name="clientTransportIgnoreClusterName">false</option>
        <option name="clientTransportPingTimeout">5s</option>
        <option name="clientTransportNodesSamplerInterval">5s</option>
    </elasticSeachClient>

For a Rest client:

    <elasticSeachClient class="org.nuxeo.elasticsearch.client.ESRestClientFactory">
        <option name="addressList">localhost:9200</option>
    </elasticSeachClient>

Contribution Descriptors

  • Class: org.nuxeo.elasticsearch.config.ElasticSearchClientConfig

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

  • nuxeo-runtime-2021.7.15.jar /opt/nuxeo/server/nxserver/config/elasticsearch-config.xml
    <?xml version='1.0' encoding='UTF-8'?>
    <extension point="elasticSearchClient" target="org.nuxeo.elasticsearch.ElasticSearchComponent">
        <elasticSearchClient class="org.nuxeo.elasticsearch.client.ESRestClientFactory">
          <option name="addressList"/>
          <option name="connection.timeout.ms">30000</option>
          <option name="socket.timeout.ms">20000</option>
          <option name="username"/>
          <option name="password">********</option>
          <option name="trustStorePath"/>
          <option name="trustStorePassword">********</option>
          <option name="trustStoreType"/>
          <option name="keyStorePath"/>
          <option name="keyStorePassword">********</option>
          <option name="keyStoreType"/>
          <!-- deprecated since 10.3, and actually referring to the trustStore -->
        </elasticSearchClient>
      </extension>